home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 11 / Cream of the Crop 11-1.iso / games / txbedit.zip / README.TXT < prev    next >
Text File  |  1995-05-31  |  7KB  |  211 lines
  1.                        ************************
  2.                        * PR'S BRIEFING EDITOR *
  3.                        ************************
  4.                              version 0.9
  5. --------
  6. Welcome!
  7. --------
  8.  
  9. Welcome to PR's Briefing Editor!  This program allows the user to edit
  10. the mission briefings in Descent.  With this program, Descent level editors
  11. will be able to include their own briefings with Descent, using their own
  12. pictures if they like (though it's still very tricky in this version).
  13.  
  14. This Briefing editor is not extremely user friendly.  You will have to
  15. learn a few technical terms first.  They will be mentioned in one of the
  16. sections below.
  17.  
  18. --------
  19. Versions
  20. --------
  21.  
  22. Yes, I will include version numbers and all that stuff at the start of the
  23. manual.  So far, there is only one version.
  24.  
  25. version 0.9     First beta version
  26.                 Not extremely user friendly, but does the job.
  27.  
  28. ---------------------
  29. What is a TXB file???
  30. ---------------------
  31.  
  32. Hopefully, you know what a TXB file is.  If you don't, here's a quick
  33. explanation of what they are.
  34.  
  35. TXB files are files that are actually in the DESCENT.HOG file.
  36. You can use a HOG extracter to get these files out (this program
  37. comes with a HOG extracter)
  38.  
  39. These TXB files contain text strings.  Depending on the name, they contain
  40. different information.
  41.  
  42. The file BRIEFING.TXB contains all the briefing text, that is, the text that
  43. makes up the mission briefings in Descent.  This program lets you change
  44. these briefings.
  45.  
  46. -----------------------------
  47. The format, etc. of TXB files
  48. -----------------------------
  49.  
  50. It will take up too much space to write up the format of TXB files.
  51. To properly understand them, you need to...
  52.  
  53. (1)     Decode them (convert the crap spit out by your editor when viewing
  54.         them into real text)
  55.  
  56. (2)     Understand them.  I haven't figured out what every type of file means
  57.         yet.  Even when converted to text, TXB files can include control
  58.         codes, and other funny codes.
  59.  
  60. Luckily, I have gone through the work of the above steps so you don't really
  61. need to know much about understanding the files themselves.  
  62.  
  63. -------------------------------
  64. How to use PR's Briefing Editor
  65. -------------------------------
  66.  
  67. When you start the program, you are presented with a window with nothing
  68. much in it.  You first have to load a file into the editor before it is
  69. of any use to you.
  70.  
  71. * Loading a file...
  72.   File|Open...    This command lets you open a TXB file or TXP file.
  73.                   TXB FILES TAKE TIME!!!
  74.  
  75. Once you have opened a file, you will see a list with sections in it.
  76. These sections correspond to the sections in the TXB or TXP file.
  77. You will now want to edit a section.  Double click the section in the
  78. list that you wish to edit.  After you have done this, another window
  79. will come up.  This lets you finally edit some text.
  80.  
  81. * Edit text...
  82.   Double Click an item in the list
  83.  
  84. You will see one section of briefing now.  You can change the words, add
  85. more words, delete words.  You will now be wondering what those black
  86. squares are.
  87.  
  88. * Black Squares = Control Codes
  89.  
  90. These control codes tell Descent when it gets to loading them that
  91. it has to deal with the letters/numbers after it to the end of the line
  92. in a special way.  What this means is that if Descent gets to a control
  93. code and a P after it, it knows that that is the end of page marker, and
  94. instead of displaying a P, it knows it is the end of a page.
  95.  
  96. THE ENTIRE LINE with a control code on it makes Descent do something special.
  97. Lets take ▄C1.  This tells Descent to change the text color.
  98. Just remember this
  99.  
  100. Descent looks at the ENTIRE LINE of a control code.
  101.  
  102. That means that you can't do the following:
  103.  
  104. ▄C1Hello, this is ▄C2 not the way!
  105.  
  106. This is the right way:
  107.  
  108. ▄C1
  109. Hello, this is
  110. ▄C2
  111. the right way!
  112.  
  113. You can change a control code directly by simply typing over the text in
  114. front of it, for instance, changing the C1 to a C2 by simply backspacing
  115. the 1 and typing a 2.  A much simpler way is to double-click the control
  116. code.  The Briefing Editor will then identify what it means and bring up
  117. a change box so you can change the code easily.
  118.  
  119. * Double Clicking a control code will let you change what it means easily
  120.  
  121. Say you want to change this code:
  122. ▄C1
  123. Simply double click the code, and a box will come up with the following
  124. options:
  125.  
  126. Green Text
  127. Beige Text
  128.  
  129. The Green Text will be selected, because that is currently what color the
  130. text is.  To change the code, simply select another color, beige text.
  131. When you click OK, the ▄C1 will be changed to a ▄C2 automatically, meaning
  132. beige text.
  133.  
  134. You can change models, pictures, animations, and more simply by
  135. double clicking the control codes.
  136.  
  137. I hope you understand so far...
  138.  
  139. When you want to save,
  140. select File|Save
  141.  
  142. -----------------
  143. Advanced Features
  144. -----------------
  145.  
  146. Using TXP files...
  147.  
  148. TXP files are native to PR's Briefing Editor.  These files are already
  149. decoded, so therefore take A LOT less time to load.
  150.  
  151. To use TXP files, you will have to save a TXB file as a TXP file.  To do
  152. this, in the File|Save dialog box, name your new file with a TXP extension
  153. instead of a TXB extension.  The rest is automatic...
  154.  
  155. TXP files are loaded like any TXB file, only much faster.
  156.  
  157. ---------
  158. Now What?
  159. ---------
  160.  
  161. You have now made a super-cool briefing, but how do you use it?
  162. There are 2 ways...
  163.  
  164. (1)     Copy your briefing to your Descent directory and name it BRIEFING.TXB
  165.         This will make Descent load your briefing instead of its own every
  166.         time.
  167.  
  168. (2)     Include it in a HOG file.  You can name it anything you like,
  169.         and you must put the following line in your MSN file:
  170.  
  171.         briefing = your briefing name
  172.  
  173.         Note: your briefing name in the MSN file should be WITHOUT its
  174.         TXB extension
  175.  
  176.         e.g.    briefing = chaos
  177.  
  178.         This refers to the file CHAOS.TXB
  179.  
  180.         You should see what I've done to CHAOS!
  181.         It's now got exit sequences and briefings!
  182.         (This program can't do exit sequences, yet...)
  183.  
  184. ---------
  185. Problems?
  186. ---------
  187.  
  188. Remember, this is only a beta version.  Expect bugs in the program.
  189. If you do locate a bug, don't hesitate to e-mail me.  This allows
  190. me to swat the bug before other innocent people get a buggy copy
  191. of the program.
  192.  
  193. If this program does something stupid, like erases you hard disk or anything
  194. like that, I do not take responsibility for this.  Don't worry, it won't
  195. wreck your hard drive (at least I don't think so... :-)   )
  196.  
  197. ----------
  198. That's it!
  199. ----------
  200.  
  201. Congratulations, you have gotten to the end of this manual.  I know it is
  202. not the best written thing in the world, so I will at this time provide help
  203. to those that need it badly.
  204.  
  205. E-mail:         prunge@ozemail.com.au
  206.  
  207. That's it, now do some good with this program!
  208.  
  209.  
  210.  
  211.